UI.SetRgbLed

This command changes the RGB color of a single LED or a group of LEDs. The color may be activated instantly or smoothly by a sine-wave approximated fading transition.

If the addressed LEDs are already active when this command is called, the color first fades to black (off), before the transition to the new color starts.

This command gives you direct control of the reader's LEDs. It competes with the command UI.Enable, which can be used to switch LEDs via Virtual LED port definitions (VLEDs). UI.Enable operates on a higher abstraction level. Don't mix the 2 commands as this may result in inconsistent behavior.

Properties

Command code: 0x0A20
Command timeout: 100 ms
Possible status codes: General status codes

Parameters (request frame)

Name		Type/Size	Description
LedState		Bit mask (16 bits)	A bitmask containing the physical LEDs you want to switch.
	RFU	Integer (bit mask area 0xFFF8)	Zero padding
	LeftLed	Boolean (bit 0x0004)	LED(s) on the left side of the reader On readers with only a single LED, this bit has no effect.
	RightLed	Boolean (bit 0x0002)	LED(s) on the right side of the reader On readers with only a single LED, this bit has no effect.
	SingleLed	Boolean (bit 0x0001)	Single LED of the reader On readers with 2 or more LEDs, this bit has no effect.
RgbColor		Integer (32 bits)	The target RGB color (0x00RRGGBB).
TransitionTime		Integer (16 bits)	The time for the fading transition to activate the target RGB color in ms. If a color is currently activated, this is also the time for the transition to deactivate this color first. For an immediate color activation, set the value to 0.

Returned values (response frame)

None